<html>
   <head>
      <link rel="stylesheet" type="text/css" href="style.css" />
   </head>
   <body onload="">
<h2 class="comptitle">Simple Module <i>SingleHostUnderlayConfigurator</i></h2>
<b>Package:</b> oversim.underlay.singlehostunderlay<br/><b>File: <a href="src-underlay-singlehostunderlay-SingleHostUnderlayConfigurator.ned.html">src/underlay/singlehostunderlay/SingleHostUnderlayConfigurator.ned</a></b><br/><p><a href="../doxy/classSingleHostUnderlayConfigurator.html" target="mainframe"><b>C++ definition</b></a></p>

<p>Configurator of the SingleHostUnderlay</p>
<p>Configures a single Host (with a connection to a real network)</p>
<p><b>Author:</b> Stephan Krause, Ingmar Baumgart</p>
<img src="oversim.underlay.singlehostunderlay.SingleHostUnderlayConfigurator-type.png" ismap="yes" usemap="#type-diagram"/><map name="type-diagram">
<area shape="rect" href="oversim.underlay.singlehostunderlay.SingleHostUnderlayConfigurator.html" title="SingleHostUnderlayConfigurator" alt="SingleHostUnderlayConfigurator" coords="0,0,238,40">
</map>
<h3 class="subtitle">Usage diagram:</h3>
<p>The following diagram shows usage relationships between types.
Unresolved types are missing from the diagram.
Click <a href="full-ned-usage-diagram.html">here</a> to see the full picture.</p>
<img src="oversim.underlay.singlehostunderlay.SingleHostUnderlayConfigurator-usage.png" ismap="yes" usemap="#usage-diagram"/><map name="usage-diagram"><area shape="rect" id="node1" href="oversim.underlay.singlehostunderlay.SingleHostUnderlayConfigurator.html" title="Simple Module SingleHostUnderlayConfigurator" alt="" coords="5,83,213,111">
<area shape="rect" id="node2" href="oversim.underlay.singlehostunderlay.SingleHostUnderlayNetwork.html" title="Network SingleHostUnderlayNetwork" alt="" coords="16,6,203,34">
</map>
<h3 class="subtitle">Inheritance diagram:</h3>
<p>The following diagram shows inheritance relationships for this type.
Unresolved types are missing from the diagram.
Click <a href="full-ned-inheritance-diagram.html">here</a> to see the full picture.</p>
<img src="oversim.underlay.singlehostunderlay.SingleHostUnderlayConfigurator-inheritance.png" ismap="yes" usemap="#inheritance-diagram"/><map name="inheritance-diagram"><area shape="rect" id="node1" href="oversim.underlay.singlehostunderlay.SingleHostUnderlayConfigurator.html" title="Simple Module SingleHostUnderlayConfigurator" alt="" coords="5,83,213,111">
<area shape="rect" id="node2" href="oversim.common.UnderlayConfigurator.html" title="Simple Module UnderlayConfigurator" alt="" coords="37,6,181,34">
</map>
<h3 class="subtitle">Extends:</h3>
<table>
<tr>
   <td>
      <a href="oversim.common.UnderlayConfigurator.html">UnderlayConfigurator</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p><a href="oversim.common.UnderlayConfigurator.html">UnderlayConfigurator</a> base module</p>
   </td>
</tr>
</table>
<h3 class="subtitle">Networks:</h3>
<table>
<tr>
   <td>
      <a href="oversim.underlay.singlehostunderlay.SingleHostUnderlayNetwork.html">SingleHostUnderlayNetwork</a>
      <i> (network)</i>
   </td>
   <td>

<p>The SingleHostUnderlay ned-file </p>
<p><b>See also:</b> <a href="oversim.underlay.singlehostunderlay.SingleHostUnderlayConfigurator.html">SingleHostUnderlayConfigurator</a></p>
   </td>
</tr>
</table>
<h3 class="subtitle">Parameters:</h3>
<table class="paramtable">
   <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Default value</th>
      <th>Description</th>
   </tr>
<tr class="inherited">
   <td width="150">terminalTypes</td>
   <td width="100">
      <i>string</i>
   </td>
   <td width="120"></td>
   <td>
<p>list of terminal types</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">churnGeneratorTypes</td>
   <td width="100">
      <i>string</i>
   </td>
   <td width="120"></td>
   <td>
<p>a list of churn generators to be used</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">transitionTime</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>time to wait before measuring after init phase is finished</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">measurementTime</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>duration of the simulation after init and transition phase</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">gracefulLeaveDelay</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>time between prekill and removal from overlay</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">gracefulLeaveProbability</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>probability of gracefull leave</p>
   </td>
</tr>
<tr class="local">
   <td width="150">nodeIP</td>
   <td width="100">
      <i>string</i>
   </td>
   <td width="120"></td>
   <td>
<p>IP of the node</p>
   </td>
</tr>
<tr class="local">
   <td width="150">nodeInterface</td>
   <td width="100">
      <i>string</i>
   </td>
   <td width="120"></td>
   <td>
<p>interface name</p>
   </td>
</tr>
<tr class="local">
   <td width="150">stunServer</td>
   <td width="100">
      <i>string</i>
   </td>
   <td width="120"></td>
   <td>
<p>name of a STUN server (optional)</p>
   </td>
</tr>
<tr class="local">
   <td width="150">bootstrapIP</td>
   <td width="100">
      <i>string</i>
   </td>
   <td width="120"></td>
   <td>
<p>IP of an overlay node for bootstrapping</p>
   </td>
</tr>
<tr class="local">
   <td width="150">bootstrapPort</td>
   <td width="100">
      <i>int</i>
   </td>
   <td width="120"></td>
   <td>
<p>Port of the bootstrap node</p>
   </td>
</tr>
</table>
<h3 class="subtitle">Properties:</h3>
<table class="paramtable">
   <tr>
      <th>Name</th>
      <th>Value</th>
      <th>Description</th>
   </tr>
<tr>
   <td width="150">display</td>
   <td width="100"><i>i=block/cogwheel</i></td>
   <td></td>
</tr>
<tr>
   <td width="150">class</td>
   <td width="100"><i>SingleHostUnderlayConfigurator</i></td>
   <td></td>
</tr>
</table>
<h3 class="subtitle">Source code:</h3>
<pre class="src"><span style="color: #808080; font-style: italic; ">//
// Configurator of the SingleHostUnderlay
//
// Configures a single Host (with a connection to a real network)
//
// </span><span style="color: #000080; ">@author</span><span style="color: #808080; font-style: italic; "> Stephan Krause, Ingmar Baumgart
//
</span><span style="color: #800000; font-weight: bold; ">simple</span><span style="color: #000000; "> </span><span style="color: #000000; ">SingleHostUnderlayConfigurator</span><span style="color: #000000; "> </span><span style="color: #800000; font-weight: bold; ">extends</span><span style="color: #000000; "> </span><span style="color: #000000; ">UnderlayConfigurator</span><span style="color: #000000; ">
{
    </span><span style="color: #800000; font-weight: bold; ">parameters</span><span style="color: #000000; ">:
        </span><span style="color: #000000; font-weight: bold; ">@class</span><span style="color: #000000; ">(</span><span style="color: #000000; ">SingleHostUnderlayConfigurator</span><span style="color: #000000; ">);
        </span><span style="color: #000080; font-weight: bold; ">string</span><span style="color: #000000; "> </span><span style="color: #000000; ">nodeIP</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// IP of the node
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">string</span><span style="color: #000000; "> </span><span style="color: #000000; ">nodeInterface</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// interface name 
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">string</span><span style="color: #000000; "> </span><span style="color: #000000; ">stunServer</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// name of a STUN server (optional)
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">string</span><span style="color: #000000; "> </span><span style="color: #000000; ">bootstrapIP</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// IP of an overlay node for bootstrapping
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">int</span><span style="color: #000000; "> </span><span style="color: #000000; ">bootstrapPort</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// Port of the bootstrap node
</span><span style="color: #000000; ">}
</span></pre>
   <hr><p class="footer"><a href="http://creativecommons.org/licenses/by-sa/3.0" target="_top"><img src="by-sa.png"></a> This documentation is released under the <a href="http://creativecommons.org/licenses/by-sa/3.0" target="_top">Creative Commons license</a></p>
   </body>
</html>
